home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1995 October / EnigmA AMIGA RUN 01 (1995)(G.R. Edizioni)(IT)[!][issue 1995-10][Aminet 7].iso / Aminet / comm / fido / ROCK14.lha / Rock.DOC < prev    next >
Text File  |  1995-04-18  |  9KB  |  274 lines
  1.  
  2. **************************************************************************
  3.  
  4.               Rock v1.4 - Fidonet mailer for point systems
  5.                   Copyright (C) 1995  Jean-Marc Xiume'
  6.           This software is distributed under the terms of the
  7.      GNU General Public License. Read "license.doc" for more details.
  8.  
  9.  
  10.      Rock is based upon POP, Copyright (c) 1994 Denis Turcotte
  11.      and JAZ Copyright (c) 1994 Robert Williamson
  12.      All wpl code except for modifications specific to ROCK, 
  13.      is copyright (c) 1994 Denis Turcotte and Robert Williamson
  14.      Rock.rexx except for modifications specific to ROCK, 
  15.      is copyright (c) 1994 Robert Williamson
  16.      LaunchWPL is copyright (C) 1994 Robert Williamson   
  17.      xferq.library is copyright (c) 1993 David Jones 
  18.      and (c) 1994, 1995 Robert Williamson
  19.      wpl.library is copyright (c) 1993 Russell McOrmond
  20.  
  21. **************************************************************************
  22.  
  23.  
  24.  
  25. Introduction
  26. ------------
  27.  
  28. Welcome to Rock, one of the smallest Point mailers available for the
  29. Amiga. It's written using the WPL and Arexx languages.
  30.  
  31. Rock is based upon POP, the world's smallest mailer, by Denis Turcotte,
  32. and on JAZ v1.01 by Robert Williamson (for the rock.rexx script).
  33.  
  34. Rock is pretty easy to install and to configure, is not memory and disk
  35. space hungry, and allows to call the all the different phone numbers of
  36. your boss if the line is busy.
  37.  
  38. For calls to other systems than the boss, it can make use of the nodelist
  39. if you already have installed the traplist.library, otherwise it asks for
  40. the phone number.
  41.  
  42. To keep things simple, the only available protocols are WAZOO for
  43. negociation and ZEDZAP for file transfer.
  44.  
  45. An example configuration file (ROCK.cfg) and the related doc (RockCfg.doc)
  46. are given.
  47.  
  48.  
  49.  
  50. Installation
  51. ------------
  52.  
  53. Simply copy the ROCK directory where you want, and assign "rock:" to that
  54. directory. You should add a line like the following one in your
  55. user-startup:
  56.  
  57. Assign rock: DH1:Fidonet/Rock
  58.  
  59. The libraries in the distribution's libs directory (wpl.library,
  60. xferq.library, and xprzedzap.library) must be accessible to the system.
  61. You can either copy them in the libs: directory, or add the following
  62. line to your user-startup:
  63.  
  64. Assign libs: rock:libs add
  65.  
  66. To properly unarchive files and preserve file attributes you should use
  67. the -a option of LHA, or manualy set the "s" flag of "rock" and "boss"
  68. with the protect command. ( e.g.: protect rock +s )
  69.  
  70. Before starting to use Rock, you must configure it. Read "RockCfg.doc",
  71. then modify the configuration file "rock.cfg" to suit your needs.
  72.  
  73. If you want, you can use the Fidonet Nodelist in traplist format. The
  74. traplist software must be installed and the traplist.library must be in
  75. the libs: directory.
  76.  
  77.  
  78.  
  79. Usage
  80. -----
  81.  
  82. Amigados template: rock ADDRESS,CONFIG
  83.  
  84. To start a session with your boss, just type "Rock" in the shell, or
  85. click on the BOSS icon (the "s" flag must be set for those files,
  86. see installation).
  87.  
  88. To call another system, give its 4D address as an argument on the
  89. command line (ex: ROCK 1:167/151.0), Rock will then ask for the phone
  90. number and the password for this system.
  91.  
  92. If you use the nodelist (see the nodelist parameter in the configuration
  93. file), rock will try to find these datas there. If it cannot find them,
  94. it will ask to enter manually, like above.
  95.  
  96. You can also give the name of the config file to use as an argument,
  97. for example if you want to poll more than one BBS.
  98. It's a standard amigados template, so if you give a config file name
  99. and no address you have to use the "config" keyword.
  100.  
  101. Examples:
  102.     rock
  103.     rock 2:320/104
  104.     rock 2:320/109 tlcsbbs.cfg
  105.     rock config tlcsbbs.cfg
  106.  
  107.  
  108. You can terminate rock by pressing control-c in its window.
  109.  
  110.  
  111.  
  112. Support Scripts
  113. ---------------
  114.  
  115. The "KillRock" script is for... trying to kill Rock if things go wrong.
  116.  
  117.  
  118. The Arexx script "WaitRock" waits for rock to terminate. It can be used,
  119. for example, in an amigados script like this:
  120.   ...
  121.   rock:rock             ;start rock
  122.   wait 3                ;allow it some time to declare its arexx port
  123.   rx rock:waitrock.rexx ;wait until the end of the session
  124.   ...
  125. This scripts accepts as an argument the number of seconds to wait between
  126. each test, in order to optimize the CPU time used.
  127.  
  128.  
  129. To start Rock from Spot, use the "StartRock.spot" script from the Arexx
  130. menu in Spot.
  131.  
  132.  
  133.  
  134. Notes
  135. -----
  136.  
  137. Rock is MailWare. If you like it, please send me a nice postcard of your
  138. country (or if you're too lazy a NetMail will do :-) ). It not only
  139. makes me happy but allows me to register the users for a better support.
  140.  
  141.  
  142. Enjoy !... :-)
  143.  
  144. Comments and suggestions are welcome:
  145.  
  146. smail:     Jean-Marc Xiumé
  147.            Parc du Belvédère
  148.            83120 Sainte-Maxime
  149.            FRANCE
  150.  
  151. fidonet :  2:320/104.22
  152. amiganet:  39:180/1.22
  153. usenet  :  jmx@ramses.fdn.org
  154.            jmx@ramses.telesys-innov.fr
  155.  
  156.  
  157.  
  158.  
  159. Thanks to
  160. ---------
  161.  
  162. - All those who created WPL
  163. - Denis Turcotte for the original idea and wpl script
  164. - Robert Williamson for the XferQ management script
  165.  
  166. - Arnaud Meurgues, Alain Chofardet, and Luc Gibert for beta testing
  167.   and improvement ideas.
  168.  
  169.  
  170.  
  171. History
  172. -------
  173. * Rock 1.4 - 19 apr 1995
  174.  - corrected invalid copyright notices
  175.  - added missing copyright notices 
  176.  - removed the possibly privatee version of wpl.library v0.99.02 and replaced it
  177.    with the public version 0.97.04
  178.  - replaced obsolete xprzedzap.library 0.56j with the current version 3.5
  179.  - corrected xprsetup command for new xprzedzap.library
  180.  
  181.  
  182. * Rock 1.3 - 01 mar 1995
  183.  
  184. - "waitrock" support script. Waits until rock exits.
  185.  
  186.  
  187. * Rock 1.3beta5 - 12 feb 1995
  188.  
  189. - ** Warning, configuration file modified ! Read the docs !! **
  190.   . Parameters grouped in 5 sections (nets,fido,modem,display,files).
  191.   . Added the addresses of the boss' different nets (fidonet,
  192.     amiganet...).
  193.   . Added the initloop and initwait parameters, for modem initialization
  194.     purpose.
  195.   . Added the minbaud parameter, to hang up the modem if the connexion
  196.     speed with the boss is lower than minbaud.
  197.   . Changed the names of the display variables.
  198.   . Added the closestatus parameter, to choose if the status window will
  199.     close itself of not, after rock has exited.
  200.   . Added the nodelist parameter. It's the path of the directory where
  201.     are the nodelist files.
  202. - It's now possible to use the NodeList ! (traplist format).
  203. - The configuration parameters have now a default value, except of course
  204.   those in the FIDO section.
  205. - Suppressed the .FLO part in the "rock" script. This is now done by the
  206.   new "bossflo.rexx" script.
  207. - No need to change the "rock" script any more, neither for the boss main
  208.   address, nor for the different nets. All is now done in "rock.cfg".
  209. - Changed the modem init phase.
  210. - Automatic creation of the xferq directory ("assignxferq" script)
  211. - Updated the config-file doc, be sure to read it.
  212. - The validity of the given address is now checked before calling, by the
  213.   new "addrcheck.rexx" script.
  214. - New "nodelist.rexx" script, to find the node's phone number and password
  215.   in the nodelist.
  216. - Corrected a bug in rock.rexx . The .?LO files with a CR as line-end
  217.   caracter are now handled correctly.
  218. - New "config" argument to the "rock" script, in order to use the config
  219.   file of your choice.
  220.  
  221.  
  222. * Rock 1.2c - 30 dec 1994
  223.  
  224. Unrealeased developpement version.
  225.  
  226.  
  227. * Rock 1.2b - 14 dec 1994
  228.  
  229. - Some minor changes.
  230.  
  231.  
  232. * Rock 1.2a - 01 oct 1994
  233.  
  234. - Rock is now able to open its windows on a given public screen.
  235.  
  236.  
  237. * Rock 1.2  - 28 sep 1994
  238.  
  239. - Amigados launch script "rock" changed in order to concatenate the .FLO
  240.   files of the different nets in a single file named with the main address
  241.   of the boss. Previously, rock sent only the fidonet files.
  242. - Added the different addresses of the boss in the config file, in order
  243.   to have the correct address for each called phone number.
  244. - Added "bossoutbound.rexx" script to rename the .?LO, .?UT and .REQ files
  245.   according to the current called boss address. Rock doesn't support AKAs,
  246.   and send only the files that match the current address.
  247. - The logfile reports if the given address doesn't match the one we are
  248.   connected to.
  249. - Rock.wpl updated according to the above changes.
  250.  
  251.  
  252. * Rock 1.1  - 24 sep 1994
  253.  
  254. - The Rock.rexx script has been corrected, as the previous didn't sent
  255.   out the file-attaches (at least in my tests with Trapdoor ;) ).
  256. - Use of the ROCK: assign instead of Mail: for Rock's files.
  257. - The logfile gives more details on what's going on:
  258.   . date and time at the beginning of each line.
  259.   . start and exit point of the program.
  260.   . address ans phone number of the called system.
  261.   . reports the reply message from the modem.
  262.   . tells if an error has occured or if the session has been manually
  263.     aborted.
  264.   . after the negociation, gives the name of the called system, the name
  265.     of the sysop, and the name of his mailer.
  266.   . session connect time (ROCKtime.rexx).
  267. - Various changes in ROCK.wpl.
  268. - KillRock script, just in case ;)
  269.  
  270.  
  271. * POP 0.9 *
  272.  
  273. Original version by Denis Turcotte.
  274.